Class VariableManagerImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.VariableManagerImpl
All Implemented Interfaces:
IPCObject, VariableManager

public class VariableManagerImpl extends IPCObjectImpl implements VariableManager
Information provided by the PKI file:

    \class VariableManager
    
    \brief VariableManager manages the variables and pools in an activity.
    
    \example appWindow().getActiveFile().getVariableManager()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getVariableSize

      public int getVariableSize()
      Information provided by the PKI file:
      
          \brief Returns the total number of variables.
          
          \return int, the total number of variables.
          
              
      Specified by:
      getVariableSize in interface VariableManager
      Returns:
      int Returns a int
    • getVariable

      public Variable getVariable(int i)
      Information provided by the PKI file:
      
          \brief Returns the variable at the specified index.
          
          \param i, the index of the variable of interest.
          
          \return Variable, the Variable object at the specified index.
          
              
      Specified by:
      getVariable in interface VariableManager
      Parameters:
      i - Takes in a parameter of i
      Returns:
      Variable Returns a Variable
    • getVariableByName

      public Variable getVariableByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the variable with the specified name.
          
          \param name, the name of the variable of interest.
          
          \return Variable, the Variable object with the specified name.
          
              
      Specified by:
      getVariableByName in interface VariableManager
      Parameters:
      name - Takes in a parameter of name
      Returns:
      Variable Returns a Variable
    • getNumberPoolSize

      public int getNumberPoolSize()
      Information provided by the PKI file:
      
          \brief Returns the number of variables in the number pool.
          
          \return int, the number of variables in the number pool.
          
              
      Specified by:
      getNumberPoolSize in interface VariableManager
      Returns:
      int Returns a int
    • getStringPoolSize

      public int getStringPoolSize()
      Information provided by the PKI file:
      
          \brief Returns the number of variables in the string pool.
          
          \return int, the number of variables in the string pool.
          
              
      Specified by:
      getStringPoolSize in interface VariableManager
      Returns:
      int Returns a int
    • getIpPoolSize

      public int getIpPoolSize()
      Information provided by the PKI file:
      
          \brief Returns the number of variables in the IP pool.
          
          \return int, the number of variables in the IP pool.
          
              
      Specified by:
      getIpPoolSize in interface VariableManager
      Returns:
      int Returns a int
    • getNumberPoolAt

      public Pool getNumberPoolAt(int i)
      Information provided by the PKI file:
      
          \brief Returns the number pool at the specified index.
          
          \param i, the index of the number pool of interest.
          
          \return Pool, the Pool object at the specified index.
          
              
      Specified by:
      getNumberPoolAt in interface VariableManager
      Parameters:
      i - Takes in a parameter of i
      Returns:
      Pool Returns a Pool
    • getStringPoolAt

      public Pool getStringPoolAt(int i)
      Information provided by the PKI file:
      
          \brief Returns the string pool at the specified index.
          
          \param i, the index of the string pool of interest.
          
          \return Pool, the Pool object at the specified index.
          
              
      Specified by:
      getStringPoolAt in interface VariableManager
      Parameters:
      i - Takes in a parameter of i
      Returns:
      Pool Returns a Pool
    • getIpPoolAt

      public Pool getIpPoolAt(int i)
      Information provided by the PKI file:
      
          \brief Returns the IP pool at the specified index.
          
          \param i, the index of the IP pool of interest.
          
          \return Pool, the Pool object at the specified index.
          
              
      Specified by:
      getIpPoolAt in interface VariableManager
      Parameters:
      i - Takes in a parameter of i
      Returns:
      Pool Returns a Pool